<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">











<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <title>Doxia Module: Syntax Highlighted Snippet - </title>
    <style type="text/css" media="all">
      @import url("./css/maven-base.css");
      @import url("./css/maven-theme.css");
      @import url("./css/site.css");
    </style>
    <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
        <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
                                                    
<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
                                                        
<script src="http://www.google-analytics.com/urchin.js" type="text/javascript">_uacct = "UA-140879-1";
        urchinTracker();</script>
                    </head>
  <body class="composite">
    <div id="banner">
                  <a href="http://maven.apache.org/doxia/doxia/doxia-modules" id="bannerLeft">
    
                                    <img src="http://maven.apache.org/doxia/doxia/images/apache-maven-project-2.png" alt="" />
    
            </a>
                        <a href="http://maven.apache.org/doxia/doxia/doxia-modules" id="bannerRight">
    
                                    <img src="http://maven.apache.org/doxia/doxia/images/maven-logo-2.gif" alt="" />
    
            </a>
            <div class="clear">
        <hr/>
      </div>
    </div>
    <div id="breadcrumbs">
          
  

  
    
            
  
    
            <div class="xleft">
        Version: 1.0-alpha-11
              </div>
            <div class="xright">            <a href="http://www.apache.org/" class="externalLink">Apache</a>
            |
                <a href="http://maven.apache.org/../maven-1.x" class="externalLink">Maven 1.x</a>
            |
                <a href="http://maven.apache.org/../" class="externalLink">Maven 2.x</a>
            |
                <a href="http://maven.apache.org/../scm" class="externalLink">SCM</a>
            |
                <a href="http://maven.apache.org/../wagon" class="externalLink">Wagon</a>
            |
                <a href="http://maven.apache.org/../jxr" class="externalLink">JXR</a>
            |
                <a href="http://maven.apache.org/" class="externalLink">Doxia</a>
            |
                <a href="http://maven.apache.org/maven-1.x" class="externalLink">Maven 1.x</a>
            |
                <a href="http://maven.apache.org/" class="externalLink">Maven 2.x</a>
            |
                <a href="http://maven.apache.org/scm" class="externalLink">SCM</a>
            |
                <a href="http://maven.apache.org/wagon" class="externalLink">Wagon</a>
            |
                <a href="http://maven.apache.org/jxr" class="externalLink">JXR</a>
            |
                <a href="http://maven.apache.org/doxia" class="externalLink">Doxia</a>
            
  

  
    
            
  
    
            &nbsp;| Last Published: 16 Feb 2009
            </div>
      <div class="clear">
        <hr/>
      </div>
    </div>
    <div id="leftColumn">
      <div id="navcolumn">
           
  

  
    
            
  
    
                   <h5>Main</h5>
            <ul>
              
    <li class="none">
                    <a href="index.html">About</a>
          </li>
              
    <li class="none">
              <strong>Manual</strong>
        </li>
          </ul>
              <h5>Download</h5>
            <ul>
              
    <li class="none">
                    <a href="http://192.168.10.40/artifactory/repo/sk/dvsk/maven/syntax-highlighted-snippet/1.0-alpha-11/syntax-highlighted-snippet-1.0-alpha-11.jar" class="externalLink">JAR</a>
          </li>
              
    <li class="none">
                    <a href="http://192.168.10.40/artifactory/repo/sk/dvsk/maven/syntax-highlighted-snippet/1.0-alpha-11/syntax-highlighted-snippet-1.0-alpha-11-sources.jar" class="externalLink">Source</a>
          </li>
          </ul>
              <h5>Parent Project</h5>
            <ul>
              
    <li class="none">
                    <a href="http://maven.apache.org/doxia/doxia/doxia-modules/index.html" class="externalLink">Doxia :: Modules</a>
          </li>
          </ul>
                        <h5>Project Documentation</h5>
            <ul>
              
                
              
      
            
      
            
      
            
      
            
      
            
      
            
      
            
      
            
      
            
      
            
      
              
        <li class="collapsed">
                    <a href="project-info.html">Project Information</a>
                </li>
              
                
              
      
              
        <li class="collapsed">
                    <a href="project-reports.html">Project Reports</a>
                </li>
          </ul>
                                           <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
            <img alt="Built by Maven" src="./images/logos/maven-feather.png"></img>
          </a>
                       
  

  
    
            
  
    
        </div>
    </div>
    <div id="bodyColumn">
      <div id="contentBox">
        <div class="section"><h2>Manual</h2>
<p>This project contains two macros <b>code-snippet</b>
 and <b>enable-highlighter</b>
.</p>
<p>First macro includes fragment of code or whole file into generated documentation. Second macro includes <a href="http://code.google.com/p/syntaxhighlighter/" class="externalLink">SyntaxHighlighter</a>
 code to enable highlighting of included fragments. Macro <tt>enable-highlighter</tt>
 shoud be used only ones per page - after all occurrences of macro <tt>code-snippet</tt>
 which can be used many times.</p>
<div class="section"><h3>code-snippet</h3>
<table class="bodyTable"><tbody><tr class="a"><td align="center"><b>Parameter</b>
</td>
<td align="left"><b>Description</b>
</td>
</tr>
<tr class="b"><td align="center"><tt>id</tt>
</td>
<td align="left">Id of snippet. See subsection <i>how to declare snippet</i>
.<br />
This parameter is <i>optional</i>
, if is missing whole file is included.</td>
</tr>
<tr class="a"><td align="center"><tt>url</tt>
 or <tt>file</tt>
</td>
<td align="left">One of these parameters is <i>required</i>
.<br />
Define location of resource containing code which is going to be included.<br />
File can be defined relative to ${base} directory.</td>
</tr>
<tr class="b"><td align="center"><tt>code</tt>
</td>
<td align="left">Define code language of snippet (see <a href="http://code.google.com/p/syntaxhighlighter/wiki/Languages" class="externalLink"> list of supported languages</a>
).<br />
This parameter is <i>optional</i>
. Language is default determined from file (or url) extension.</td>
</tr>
<tr class="a"><td align="center"><tt>encoding</tt>
</td>
<td align="left"><i>Optional</i>
. Default is used UTF-8.</td>
</tr>
</tbody>
</table>
<div class="section"><h4>How to declare snippet</h4>
<p>TODO</p>
</div>
</div>
</div>

      </div>
    </div>
    <div class="clear">
      <hr/>
    </div>
    <div id="footer">
      <div class="xright">&#169;  
          2002-2009
    
          The Apache Software Foundation
          
  

  
    
            
  
    
  </div>
      <div class="clear">
        <hr/>
      </div>
    </div>
  </body>
</html>
